Open
Conversation
Contributor
Author
|
Displaying version at the top of the sidebar seems deprecated since v3: https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html#confval-display_version |
… HTML theme options
…y CSS file reference
Contributor
Author
|
BSDF-related codes were deleted (#349), but some documents still remain: source/docs/source/demonstrations/demonstrations.rst Lines 87 to 96 in 2487a86 The missing demo scripts trigger warnings during a document build like this: WARNING: Include file '.../source/demos/reflectivity/plotting_brdfs.py' not found or reading it failed [docutils]
WARNING: Include file '.../source/demos/reflectivity/plotting_brdfs_3d.py' not found or reading it failed [docutils]How should we handle this? |
Contributor
Author
|
Additionally, there are many outdated RST files visible: source/docs/source/api_reference/core/raysect_core_kdtree.rst: WARNING: document isn't included in any toctree [toc.not_included]
source/docs/source/architecture.rst: WARNING: document isn't included in any toctree [toc.not_included]
source/docs/source/demonstrations/core/energy_conservation.rst: WARNING: document isn't included in any toctree [toc.not_included]
source/docs/source/demonstrations/core/multiple_importance_sampling.rst: WARNING: document isn't included in any toctree [toc.not_included]
source/docs/source/demonstrations/core/ray_intersection_points.rst: WARNING: document isn't included in any toctree [toc.not_included]
source/docs/source/demonstrations/core/world_contains_point.rst: WARNING: document isn't included in any toctree [toc.not_included]
source/docs/source/demonstrations/materials/anisotropic_emitters.rst: WARNING: document isn't included in any toctree [toc.not_included]
source/docs/source/demonstrations/materials/diamond.rst: WARNING: document isn't included in any toctree [toc.not_included]
source/docs/source/demonstrations/materials/diffuse_colours.rst: WARNING: document isn't included in any toctree [toc.not_included]
source/docs/source/demonstrations/materials/emissive_colours.rst: WARNING: document isn't included in any toctree [toc.not_included]
source/docs/source/demonstrations/materials/glass_bunny.rst: WARNING: document isn't included in any toctree [toc.not_included]
source/docs/source/demonstrations/materials/metal_materials.rst: WARNING: document isn't included in any toctree [toc.not_included]
source/docs/source/demonstrations/materials/polar_brdf_plots.rst: WARNING: document isn't included in any toctree [toc.not_included]
source/docs/source/demonstrations/materials/surface3d_brdf_plots.rst: WARNING: document isn't included in any toctree [toc.not_included]
source/docs/source/demonstrations/materials/surface_roughness.rst: WARNING: document isn't included in any toctree [toc.not_included]
source/docs/source/demonstrations/materials/tetrahedra_mesh_emitter.rst: WARNING: document isn't included in any toctree [toc.not_included]
source/docs/source/demonstrations/materials/volume_inhomogeneous.rst: WARNING: document isn't included in any toctree [toc.not_included]
source/docs/source/demonstrations/observers/animations.rst: WARNING: document isn't included in any toctree [toc.not_included]
source/docs/source/demonstrations/observers/cornell_box.rst: WARNING: document isn't included in any toctree [toc.not_included]
source/docs/source/demonstrations/observers/cornell_box_with_camera.rst: WARNING: document isn't included in any toctree [toc.not_included]
source/docs/source/demonstrations/observers/mesh_observers.rst: WARNING: document isn't included in any toctree [toc.not_included]
source/docs/source/demonstrations/observers/metal_balls_with_lens.rst: WARNING: document isn't included in any toctree [toc.not_included]
source/docs/source/demonstrations/observers/optical_fibre.rst: WARNING: document isn't included in any toctree [toc.not_included]
source/docs/source/demonstrations/observers/orthographic_camera.rst: WARNING: document isn't included in any toctree [toc.not_included]
source/docs/source/demonstrations/optics/etendue_of_pinhole.rst: WARNING: document isn't included in any toctree [toc.not_included]
source/docs/source/demonstrations/optics/prism.rst: WARNING: document isn't included in any toctree [toc.not_included]
source/docs/source/quickstart_more.rst: WARNING: document isn't included in any toctree [toc.not_included]
source/docs/source/sampling.rst: WARNING: document isn't included in any toctree [toc.not_included] |
…nd remove scipy and python v2 mention
…ion commands and clarify source installation process
…ools in installation documentation
Member
|
Thanks for working to update the docs. I didn't have time to go through them. Feel free to clean up any stale files, they will be in the repository history. Happy to merge this when you are ready. |
Contributor
Author
|
I got it! @CnlPepper Regarding BRDF plotting demo issue, I would also try to figure out how to reproduce demo scripts. |
Apply correct types, Fix error strings and Fix error indent
demo docs are referenced with the internal hyperlink, so add `:orphan:` to remove not-included into toctree warning.
Contributor
Author
|
There are still warnings about cross-referencing classes, as shown below. WARNING: more than one target found for cross-reference 'Ray': raysect.core.ray.Ray, raysect.optical.ray.Ray [ref.python]
WARNING: more than one target found for cross-reference 'World': raysect.core.scenegraph.world.World, raysect.optical.scenegraph.world.World [ref.python]
WARNING: more than one target found for cross-reference 'Function1D': raysect.core.math.function.float.function1d.base.Function1D, raysect.core.math.function.vector3d.function1d.base.Function1D [ref.python]
WARNING: more than one target found for cross-reference 'Function2D': raysect.core.math.function.float.function2d.base.Function2D, raysect.core.math.function.vector3d.function2d.base.Function2D [ref.python]
WARNING: more than one target found for cross-reference 'Function3D': raysect.core.math.function.float.function3d.base.Function3D, raysect.core.math.function.vector3d.function3d.base.Function3D [ref.python]Note that it might be necessary if we need to guide users to correct API definitions. |
Contributor
Author
|
There are still some warnings, except for those mentioned above (build log). However, this PR should be ready for review @CnlPepper . The other warning: WARNING: duplicate object description of raysect.primitive.Sphere, other instance in api_reference/primitives/geometric_primitives, use :no-index: for one of them
...seems to be related to the fact that the |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Issues
Fix the incorrectly spelled
targettedin the document #455sphinx_rtd_themeis incompatible with the current style settings.docs: Unnatural document appearance #456
docs: Update the installation guide #458
TODO list
Fix the incorrectly spelled
targettedin the document #455docs: Unnatural document appearance #456
docs: Update the installation guide #458
LoggingRayPreview demo site
The modified documentation site preview is available here:
https://munechika-koyo.github.io/source/